<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Phing API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="css/jquery-ui.css" type="text/css"></link><link rel="stylesheet" href="css/docblox/jquery-ui-1.8.16.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.tools.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
            $(document).ready(function() {
                $(".filetree").treeview({
                    collapsed: true,
                    persist: "cookie"
                });

                $("#accordion").accordion({
                    collapsible: true,
                    autoHeight:  false,
                    fillSpace:   true
                });

                $(".tabs").tabs();
            });
        </script></head><body><div xmlns="" id="content">
<script xmlns:dbx="http://docblox-project.org/xsl/functions">

      function filterElements()
      {
        inherited = !$('#show-inherited').hasClass('deselected');
        public    = !$('#show-public').hasClass('deselected');
        protected = !$('#show-protected').hasClass('deselected');
        private   = !$('#show-private').hasClass('deselected');

        $('div.public').each(function(index, val) {
            $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.protected').each(function(index, val) {
            $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.private').each(function(index, val) {
            $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
        });
      }

      $(document).ready(function() {
        $('a.gripper').click(function() {
            $(this).nextAll('div.code-tabs').slideToggle();
            $(this).children('img').toggle();
            return false;
        });

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
            $(this).parent().nextAll('div.code-tabs').slideToggle();
            $(this).parent().prevAll('a.gripper').children('img').toggle();
            return false;
        });

        $('div.code-tabs').hide();
        $('a.gripper').show();
        $('div.code-tabs:empty').prevAll('a.gripper').html('');

        $('#show-public, #show-protected, #show-private, #show-inherited')
            .css('cursor', 'pointer')
            .click(function(){
                $(this).toggleClass('deselected');
                if ($(this).hasClass('deselected')) {
                  $(this).fadeTo('fast', '0.4');
                } else {
                  $(this).fadeTo('fast', '1.0');
                }
                filterElements();
                return false;
            });
        $('#show-protected, #show-private').click();

        // add the sliding behaviour to the file navigation and show it
        // it is initially hidden for non-JS users.
        $("#file-nav-box").show().hover(function() {
            $("#file-nav-container").slideDown(400);
        }, function() {
            $("#file-nav-container").slideUp(400);
        });
      });

      
    </script><h1 xmlns:dbx="http://docblox-project.org/xsl/functions" class="file">tasks/ext/phpdoc/PhpDocumentorExternalTask.php</h1>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" id="file-nav-box">
<div id="file-nav-options">
              Show:
              <img src="images/icons/visibility_public.png" id="show-public"><img src="images/icons/visibility_protected.png" id="show-protected"><img src="images/icons/visibility_private.png" id="show-private"><span class="attribute" id="show-inherited">inherited</span>
</div>
<div id="file-nav-container">
<ul id="file-nav"><li>
<a href="#classes"><img src="images/icons/class.png" height="14">
                          Classes
                      </a><ul><li><a href="#%5CPhpDocumentorExternalTask">\PhpDocumentorExternalTask</a></li></ul>
</li></ul>
<div style="clear: left;"></div>
</div>
<div id="file-nav-tab">
              Table of Contents
          </div>
</div>
<a xmlns:dbx="http://docblox-project.org/xsl/functions" name="top" class="anchor"></a><div id="file-description">
<p xmlns:dbx="http://docblox-project.org/xsl/functions" class="short-description">$Id: PhpDocumentorExternalTask.php 656 2009-12-14 14:10:54Z mrook $</p>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="long-description"><p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>

<p>This software consists of voluntary contributions made by many individuals
and is licensed under the LGPL. For more information please see
<a href="http://phing.info">http://phing.info</a>.</p></div>
</div>
<a name="classes" class="anchor"></a><a xmlns:dbx="http://docblox-project.org/xsl/functions" id="\PhpDocumentorExternalTask" class="anchor"></a><h2 xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">\PhpDocumentorExternalTask<div class="to-top"><a href="#top">jump to top</a></div>
</h2>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">
<small class="package"><b>Package: </b>phing\tasks\ext\phpdoc</small><p class="short-description">Task to run phpDocumentor with an external process</p>
<div class="long-description"><p>This classes uses the commandline phpdoc script to build documentation.
Use this task instead of the PhpDocumentorTask when you've a clash with the
Smarty libraries.</p></div>
<dl class="class-info">
<dt>Parent(s)</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask">\PhpDocumentorTask</a>
            &lt;
            <a href="db_Task.html#%5CTask" style="color: gray; font-size: 0.8em
                ">\Task</a>
            &lt;
            <a href="db_ProjectComponent.html#%5CProjectComponent" style="color: gray; font-size: 0.8em
                ">\ProjectComponent</a>
</dd>
<dt>Author</dt>
<dd>
<a href="mailto:michiel.rook@gmail.com">Michiel Rook</a>
         
    </dd>
<dt>Author</dt>
<dd>
<a href="mailto:markus@fischer.name">Markus Fischer</a>
         
    </dd>
<dt>Version</dt>
<dd>$Id: PhpDocumentorExternalTask.php 656 2009-12-14 14:10:54Z mrook $
         
    </dd>
</dl>
<h3>Properties</h3>
<div>
<a id="\PhpDocumentorExternalTask::$configDir" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">\PhingFile
                 <span class="highlight">$configDir</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Directory in which to look for configuration files.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24configDir">\PhpDocumentorTask::$$configDir</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_system_io_PhingFile.html#%5CPhingFile">\PhingFile</a></dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24configDir">\PhpDocumentorTask::$$configDir</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$customtags" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$customtags</span>= ''''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>custom tags, will be recognized and put in tags[] instead of unknowntags[].<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24customtags">\PhpDocumentorTask::$$customtags</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>''</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24customtags">\PhpDocumentorTask::$$customtags</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$defaultCategoryName" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$defaultCategoryName</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Default category name.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24defaultCategoryName">\PhpDocumentorTask::$$defaultCategoryName</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24defaultCategoryName">\PhpDocumentorTask::$$defaultCategoryName</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$defaultPackageName" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$defaultPackageName</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Default package name.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24defaultPackageName">\PhpDocumentorTask::$$defaultPackageName</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24defaultPackageName">\PhpDocumentorTask::$$defaultPackageName</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$destdir" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">\PhingFile
                 <span class="highlight">$destdir</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>The target directory for output files.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24destdir">\PhpDocumentorTask::$$destdir</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_system_io_PhingFile.html#%5CPhingFile">\PhingFile</a></dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24destdir">\PhpDocumentorTask::$$destdir</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$examplesDir" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">\PhingFile
                 <span class="highlight">$examplesDir</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Directory in which to look for examples.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24examplesDir">\PhpDocumentorTask::$$examplesDir</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_system_io_PhingFile.html#%5CPhingFile">\PhingFile</a></dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24examplesDir">\PhpDocumentorTask::$$examplesDir</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$filesets" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">array
                 <span class="highlight">$filesets</span>= 'array()'
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>FileSet[] Filesets for files to parse.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24filesets">\PhpDocumentorTask::$$filesets</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>array()</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>array</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24filesets">\PhpDocumentorTask::$$filesets</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$ignore" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$ignore</span>= ''''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>files to ignore<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24ignore">\PhpDocumentorTask::$$ignore</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>''</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24ignore">\PhpDocumentorTask::$$ignore</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$ignoreTags" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$ignoreTags</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Comma-separated list of tags to ignore.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24ignoreTags">\PhpDocumentorTask::$$ignoreTags</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24ignoreTags">\PhpDocumentorTask::$$ignoreTags</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$ignoresymlinks" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">bool
                 <span class="highlight">$ignoresymlinks</span>= 'false'
                </code><div class="description">
<p class="short-description"></p>ignore symlinks to other files or directories</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>bool</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$javadocDesc" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">boolean
                 <span class="highlight">$javadocDesc</span>= 'false'
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Whether to use javadoc descriptions (more primitive).<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24javadocDesc">\PhpDocumentorTask::$$javadocDesc</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>boolean</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24javadocDesc">\PhpDocumentorTask::$$javadocDesc</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$linksource" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">boolean
                 <span class="highlight">$linksource</span>= 'false'
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Whether to generate sourcecode for each file parsed.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24linksource">\PhpDocumentorTask::$$linksource</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>boolean</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24linksource">\PhpDocumentorTask::$$linksource</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$output" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$output</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Package output format.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24output">\PhpDocumentorTask::$$output</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24output">\PhpDocumentorTask::$$output</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$packages" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$packages</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Comma-separated list of packages to output.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24packages">\PhpDocumentorTask::$$packages</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24packages">\PhpDocumentorTask::$$packages</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$parsePrivate" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">boolean
                 <span class="highlight">$parsePrivate</span>= 'false'
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Whether to parse private members.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24parsePrivate">\PhpDocumentorTask::$$parsePrivate</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>boolean</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24parsePrivate">\PhpDocumentorTask::$$parsePrivate</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$pear" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">boolean
                 <span class="highlight">$pear</span>= 'false'
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Whether to parse as a PEAR repository.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24pear">\PhpDocumentorTask::$$pear</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>boolean</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24pear">\PhpDocumentorTask::$$pear</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$programPath" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">
                 <span class="highlight">$programPath</span>= ''phpdoc''
                </code><div class="description"><p class="short-description">The path to the executable for phpDocumentor</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>'phpdoc'</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>n/a</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$projDocFilesets" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">array
                 <span class="highlight">$projDocFilesets</span>= 'array()'
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>FileSet[] Project documentation (README/INSTALL/CHANGELOG) files.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24projDocFilesets">\PhpDocumentorTask::$$projDocFilesets</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>array()</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>array</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24projDocFilesets">\PhpDocumentorTask::$$projDocFilesets</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$quiet" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">boolean
                 <span class="highlight">$quiet</span>= 'false'
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Wheter to suppress output.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24quiet">\PhpDocumentorTask::$$quiet</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>boolean</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24quiet">\PhpDocumentorTask::$$quiet</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$sourcepath" class="anchor"></a><div class="property protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">
                 <span class="highlight">$sourcepath</span>= 'NULL'
                </code><div class="description"></div>
<div class="code-tabs">
<strong>Default value</strong><code>NULL</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>n/a</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$templateBase" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">\PhingFile
                 <span class="highlight">$templateBase</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Base directory for locating template files.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24templateBase">\PhpDocumentorTask::$$templateBase</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd><a href="db_system_io_PhingFile.html#%5CPhingFile">\PhingFile</a></dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24templateBase">\PhpDocumentorTask::$$templateBase</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$title" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">string
                 <span class="highlight">$title</span>= ''
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Title for browser window / package index.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24title">\PhpDocumentorTask::$$title</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>string</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24title">\PhpDocumentorTask::$$title</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::$undocumentedelements" class="anchor"></a><div class="property protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected">boolean
                 <span class="highlight">$undocumentedelements</span>= 'false'
                </code><div class="description">
<span class="attribute">inherited</span><p class="short-description"></p>Control whether or not warnings will be shown for undocumented elements. Useful for identifying classes and methods that haven't yet been documented.<small>Inherited from:
                        <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24undocumentedelements">\PhpDocumentorTask::$$undocumentedelements</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>boolean</dd>
<dt>Inherited_from</dt>
<dd>
<a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::%24%24undocumentedelements">\PhpDocumentorTask::$$undocumentedelements</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
</div>
<h3>Methods</h3>
<div>
<a id="\PhpDocumentorExternalTask::constructArguments()" class="anchor"></a><div class="method protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"><span class="highlight">constructArguments</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          array</code><div class="description"><p class="short_description">Constructs an argument string for phpDocumentor</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>array</td>
<td></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::createFileset()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">createFileset</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          <a href="db_types_FileSet.html#%5CFileSet">\FileSet</a></code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Creates a FileSet.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::createFileset()">\PhpDocumentorTask::createFileset()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_types_FileSet.html#%5CFileSet">\FileSet</a></td>
<td></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::createProjdocfileset()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">createProjdocfileset</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          <a href="db_types_FileSet.html#%5CFileSet">\FileSet</a></code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Creates a readme/install/changelog fileset.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::createProjdocfileset()">\PhpDocumentorTask::createProjdocfileset()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_types_FileSet.html#%5CFileSet">\FileSet</a></td>
<td></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::findPhpDocumentorInstall()" class="anchor"></a><div class="method protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"><span class="highlight">findPhpDocumentorInstall</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Searches include_path for PhpDocumentor install and adjusts include_path appropriately.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::findPhpDocumentorInstall()">\PhpDocumentorTask::findPhpDocumentorInstall()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Throws</strong><table class="argument-info">
<thead><tr>
<th>Exception</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_BuildException.html#%5CBuildException">\BuildException</a></td>
<td><em>- if unable to find PhpDocumentor on include_path</em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getDescription()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getDescription</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::getDescription()">Task::getDescription()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::getDescription()">\PhpDocumentorTask::getDescription()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getLocation()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getLocation</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::getLocation()">Task::getLocation()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::getLocation()">\PhpDocumentorTask::getLocation()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getOwningTarget()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getOwningTarget</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::getOwningTarget()">Task::getOwningTarget()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::getOwningTarget()">\PhpDocumentorTask::getOwningTarget()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getProgramPath()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getProgramPath</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Returns the path to the phpDocumentor executable</p></div>
<div class="code-tabs"><div class="long-description"></div></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getProject()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getProject</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_ProjectComponent.html#%5CProjectComponent::getProject()">ProjectComponent::getProject()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::getProject()">\PhpDocumentorTask::getProject()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getRegisterSlot()" class="anchor"></a><div class="method protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"><span class="highlight">getRegisterSlot</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::getRegisterSlot()">Task::getRegisterSlot()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::getRegisterSlot()">\PhpDocumentorTask::getRegisterSlot()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getRuntimeConfigurableWrapper()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getRuntimeConfigurableWrapper</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::getRuntimeConfigurableWrapper()">Task::getRuntimeConfigurableWrapper()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::getRuntimeConfigurableWrapper()">\PhpDocumentorTask::getRuntimeConfigurableWrapper()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getTaskName()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getTaskName</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::getTaskName()">Task::getTaskName()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::getTaskName()">\PhpDocumentorTask::getTaskName()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::getTaskType()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getTaskType</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::getTaskType()">Task::getTaskType()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::getTaskType()">\PhpDocumentorTask::getTaskType()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::init()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">init</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Override PhpDocumentorTask::init() because they're specific to the phpdoc
API which we don't use.</p></div>
<div class="code-tabs"><div class="long-description"></div></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::log()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">log</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::log()">Task::log()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::log()">\PhpDocumentorTask::log()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::main()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">main</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Main entrypoint of the task</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Throws</strong><table class="argument-info">
<thead><tr>
<th>Exception</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_BuildException.html#%5CBuildException">\BuildException</a></td>
<td><em>- if the phpdoc classes can't be loaded.</em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::maybeConfigure()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">maybeConfigure</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::maybeConfigure()">Task::maybeConfigure()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::maybeConfigure()">\PhpDocumentorTask::maybeConfigure()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::perform()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">perform</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::perform()">Task::perform()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::perform()">\PhpDocumentorTask::perform()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setConfigdir()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setConfigdir</span><span class="nb-faded-text">(
          <a href="db_system_io_PhingFile.html#%5CPhingFile">\PhingFile</a> $d
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set a directory to search for configuration files in.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setConfigdir()">\PhpDocumentorTask::setConfigdir()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$d</th>
<td><a href="db_system_io_PhingFile.html#%5CPhingFile">\PhingFile</a></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setCustomtags()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setCustomtags</span><span class="nb-faded-text">(
          string $sCustomtags
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">custom tags, will be recognized and put in tags[] instead of
unknowntags[].</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setCustomtags()">\PhpDocumentorTask::setCustomtags()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$sCustomtags</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setDefaultcategoryname()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setDefaultcategoryname</span><span class="nb-faded-text">(
          string $name
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Sets the default category name.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setDefaultcategoryname()">\PhpDocumentorTask::setDefaultcategoryname()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$name</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setDefaultpackagename()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setDefaultpackagename</span><span class="nb-faded-text">(
          string $name
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Sets the default package name.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setDefaultpackagename()">\PhpDocumentorTask::setDefaultpackagename()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$name</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setDescription()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setDescription</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::setDescription()">Task::setDescription()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setDescription()">\PhpDocumentorTask::setDescription()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setDestdir()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setDestdir</span><span class="nb-faded-text">(
           $destdir
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set the destination directory for the generated documentation</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setDestdir()">\PhpDocumentorTask::setDestdir()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$destdir</th>
<td></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setExamplesdir()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setExamplesdir</span><span class="nb-faded-text">(
          <a href="db_system_io_PhingFile.html#%5CPhingFile">\PhingFile</a> $d
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set a directory to search for examples in.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setExamplesdir()">\PhpDocumentorTask::setExamplesdir()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$d</th>
<td><a href="db_system_io_PhingFile.html#%5CPhingFile">\PhingFile</a></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setIgnore()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setIgnore</span><span class="nb-faded-text">(
          string $sIgnore
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set files to ignore</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setIgnore()">\PhpDocumentorTask::setIgnore()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$sIgnore</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setIgnoresymlinks()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setIgnoresymlinks</span><span class="nb-faded-text">(
          bool $bSet
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Ignore symlinks to other files or directories.</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$bSet</th>
<td>bool</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setIgnoretags()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setIgnoretags</span><span class="nb-faded-text">(
          string $tags
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set (comma-separated) list of tags to ignore.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setIgnoretags()">\PhpDocumentorTask::setIgnoretags()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$tags</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setJavadocdesc()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setJavadocdesc</span><span class="nb-faded-text">(
           $javadoc
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Whether to use javadoc descriptions (more primitive).</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setJavadocdesc()">\PhpDocumentorTask::setJavadocdesc()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$javadoc</th>
<td></td>
<td><em><p>boolean</p></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setLinksource()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setLinksource</span><span class="nb-faded-text">(
           $b
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set whether to generate sourcecode for each file parsed</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setLinksource()">\PhpDocumentorTask::setLinksource()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$b</th>
<td></td>
<td><em><p>boolean</p></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setLocation()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setLocation</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::setLocation()">Task::setLocation()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setLocation()">\PhpDocumentorTask::setLocation()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setOutput()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setOutput</span><span class="nb-faded-text">(
          string $output
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set the output format (e.g. HTML:Smarty:PHP).</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setOutput()">\PhpDocumentorTask::setOutput()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$output</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setOwningTarget()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setOwningTarget</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::setOwningTarget()">Task::setOwningTarget()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setOwningTarget()">\PhpDocumentorTask::setOwningTarget()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setPackageoutput()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setPackageoutput</span><span class="nb-faded-text">(
          string $packages
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set (comma-separated) list of packages to output.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setPackageoutput()">\PhpDocumentorTask::setPackageoutput()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$packages</th>
<td>string</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setParseprivate()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setParseprivate</span><span class="nb-faded-text">(
           $parseprivate
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Should private members/classes be documented</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setParseprivate()">\PhpDocumentorTask::setParseprivate()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$parseprivate</th>
<td></td>
<td><em><p>boolean</p></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setPear()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setPear</span><span class="nb-faded-text">(
          boolean $b
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set whether to parse as PEAR repository.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setPear()">\PhpDocumentorTask::setPear()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$b</th>
<td>boolean</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setPhpDocumentorOptions()" class="anchor"></a><div class="method protected inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"><span class="highlight">setPhpDocumentorOptions</span><span class="nb-faded-text">(
          <a href="db_tasks_ext_phpdoc_PhingPhpDocumentorSetup.html#%5CPhingPhpDocumentorSetup">\PhingPhpDocumentorSetup</a> $phpdoc
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Sets the options on the passed-in phpdoc setup object.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setPhpDocumentorOptions()">\PhpDocumentorTask::setPhpDocumentorOptions()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$phpdoc</th>
<td><a href="db_tasks_ext_phpdoc_PhingPhpDocumentorSetup.html#%5CPhingPhpDocumentorSetup">\PhingPhpDocumentorSetup</a></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setProgramPath()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setProgramPath</span><span class="nb-faded-text">(
           $programPath
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Sets the path to the phpDocumentor executable</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$programPath</th>
<td></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setProject()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setProject</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_ProjectComponent.html#%5CProjectComponent::setProject()">ProjectComponent::setProject()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setProject()">\PhpDocumentorTask::setProject()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setQuiet()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setQuiet</span><span class="nb-faded-text">(
          boolean $b
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set whether to suppress output.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setQuiet()">\PhpDocumentorTask::setQuiet()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$b</th>
<td>boolean</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setRuntimeConfigurableWrapper()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setRuntimeConfigurableWrapper</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::setRuntimeConfigurableWrapper()">Task::setRuntimeConfigurableWrapper()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setRuntimeConfigurableWrapper()">\PhpDocumentorTask::setRuntimeConfigurableWrapper()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setSourcecode()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setSourcecode</span><span class="nb-faded-text">(
           $b
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set whether to generate sourcecode for each file parsed</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setSourcecode()">\PhpDocumentorTask::setSourcecode()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$b</th>
<td></td>
<td><em><p>boolean</p></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setSourcepath()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setSourcepath</span><span class="nb-faded-text">(
           $sourcepath
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Set the source path. A directory or a comma separate list of directories.</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$sourcepath</th>
<td></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setTarget()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setTarget</span><span class="nb-faded-text">(
           $destdir
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Alias for {@link setDestdir()}.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setTarget()">\PhpDocumentorTask::setTarget()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$destdir</th>
<td></td>
<td><em></em></td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>See</dt>
<dd>\setDestdir()
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setTaskName()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setTaskName</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::setTaskName()">Task::setTaskName()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setTaskName()">\PhpDocumentorTask::setTaskName()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setTaskType()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setTaskType</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description"></p>
<small>Inherited from:
                    <a href="db_Task.html#%5CTask::setTaskType()">Task::setTaskType()</a><a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setTaskType()">\PhpDocumentorTask::setTaskType()</a></small>
</div>
<div class="code-tabs"></div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setTemplateBase()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setTemplateBase</span><span class="nb-faded-text">(
           $oTemplateBase
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set base location of all templates for this parse.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setTemplateBase()">\PhpDocumentorTask::setTemplateBase()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$oTemplateBase</th>
<td></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setTitle()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setTitle</span><span class="nb-faded-text">(
           $title
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Set the title for the generated documentation</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setTitle()">\PhpDocumentorTask::setTitle()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$title</th>
<td></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::setUndocumentedelements()" class="anchor"></a><div class="method public inherited_from ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">setUndocumentedelements</span><span class="nb-faded-text">(
          boolean $b
          )
        </span>
        :
          void</code><div class="description">
<span class="attribute">inherited</span><p class="short_description">Control whether or not warnings will be shown for undocumented elements.</p>
<small>Inherited from:
                    <a href="db_tasks_ext_phpdoc_PhpDocumentorTask.html#%5CPhpDocumentorTask::setUndocumentedelements()">\PhpDocumentorTask::setUndocumentedelements()</a></small>
</div>
<div class="code-tabs">
<div class="long-description"><p>Useful for identifying classes and methods that haven't yet been
documented.</p></div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$b</th>
<td>boolean</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\PhpDocumentorExternalTask::validate()" class="anchor"></a><div class="method protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"><span class="highlight">validate</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Validates that necessary minimum options have been set. Based on
PhpDocumentorTask::validate().</p></div>
<div class="code-tabs">
<div class="long-description"></div>
<strong>Throws</strong><table class="argument-info">
<thead><tr>
<th>Exception</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_BuildException.html#%5CBuildException">\BuildException</a></td>
<td><em>if validation doesn't pass</em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
</div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.17.1</a>.
    </small></body></html>
